Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Start documentation website #540

Merged
merged 10 commits into from
Jul 17, 2023
Merged

Conversation

mgoulao
Copy link
Contributor

@mgoulao mgoulao commented May 1, 2023

  • Add Sphinx docs
  • Move old doc to docs

Preview:
https://mgoulao.github.io/ViZDoom/

What is missing:

  • Add a gif to main page
  • Add a code snippet of gymnasium wrapper

@mgoulao mgoulao marked this pull request as draft May 1, 2023 10:10
@mwydmuch
Copy link
Member

mwydmuch commented May 2, 2023

Thank you, @mgoulao. This already looks very good. Are there any other things to do besides the ones on "What is missing" list?

@mgoulao
Copy link
Contributor Author

mgoulao commented May 3, 2023

Yes, I think we should try to move the API documentation to the code and use autodoc the retrieve them but this project has a very peculiar code structure and both Python and C++ APIs so I don't know the best approach here.

@mwydmuch mwydmuch marked this pull request as ready for review June 19, 2023 15:28
@mwydmuch mwydmuch changed the title Start documentation website (WIP) Start documentation website Jun 19, 2023
@mwydmuch mwydmuch changed the title (WIP) Start documentation website Start documentation website Jul 17, 2023
@mwydmuch mwydmuch merged commit 0a904ba into Farama-Foundation:master Jul 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants